ContentConnect

ContentConnect stellt Redakteuren die folgenden Möglichkeiten zur Verfügung:

Die entsprechenden Funktionalitäten werden mit der Installation und Konfiguration des Moduls sowohl im SiteArchitect als auch im ContentCreator bereitgestellt.

Die Pflege der Inhalte findet über die gewohnten FirstSpirit-Mittel statt. Mit FirstSpirit vertraute Redakteure benötigen daher keine darüber hinausgehenden Kenntnisse. Die Inhalte werden der Commerce Cloud im Rahmen eines Deployments zum Import bereitgestellt. Diese überträgt die Informationen in den Live-Stand.

Für die Commerce Cloud ergibt sich somit bei der Auslieferung redaktioneller Inhalte in den Live-Stand keinerlei Unterschied. Auch wenn der FirstSpirit-Server beispielsweise aufgrund von Wartungsarbeiten heruntergefahren wird, beeinflusst dies die Commerce Cloud nicht.

Die Verbindung von FirstSpirit und der Commerce Cloud wird über eine Architektur aus verschiedenen Komponenten realisiert (vgl. Abbildung Architektur). Diese Komponenten sind:

Abbildung 1. Architektur

Das Zusammenspiel der einzelnen Komponenten erfolgt immer nach dem folgenden Schema:

Die Commerce Cloud stellt somit die Hauptkomponente dieser Architektur dar. Sie liefert die in FirstSpirit erstellten bzw. gepflegten Inhalte an die Kunden aus und stellt sämtliche Shop-Funktionalitäten zur Verfügung. Zwischen beiden Systemen existiert lediglich eine lose Kopplung. Sie arbeiten hauptsächlich parallel zueinander. Wird der FirstSpirit-Server beispielsweise aufgrund von Wartungsarbeiten heruntergefahren, beeinflusst dies die Commerce Cloud nicht.

Das ContentConnect-Modul bietet die Möglichkeit, redaktionelle Inhalte FirstSpirit-seitig zu pflegen und diese anschließend per Deployment in die Commerce Cloud zu übertragen. Dafür muss die Verarbeitung von Inhalten in beiden Systemen aufeinander abgestimmt und zueinander kompatibel sein. Die nachfolgenden Unterkapitel beschreiben das zugrunde liegende Konzept, mit dem diese Kompatibilität erreicht wird.

1.3.1. Seiten

Ähnlich wie in FirstSpirit basieren Seiten in der Commerce Cloud auf einer Struktur unterschiedlicher Komponenten. Um redaktionelle Inhalte zwischen den beiden Systemen austauschen zu können, müssen diese Komponenten aufeinander abgestimmt sein.

Innerhalb des in der Auslieferung enthaltenen Referenzprojekts ContentConnect Reference Project werden die Slots durch die Inhaltsbereiche einer Seitenvorlage repräsentiert. Ihnen können Absätze hinzugefügt werden, die jeweils einem Asset entsprechen und je nach Anwendungsfall zusätzlich eine Slot-Konfiguration besitzen (vgl. Abbildung Page Rendering). Mithilfe dieser Konfigurationen lässt sich beispielsweise definieren, welche Zielgruppe den entsprechenden Inhalt sehen darf oder in welchem Zeitraum dieser sichtbar ist. Jede Slot-Konfiguration verweist auf exakt ein Asset.

Mit FirstSpirit lassen sich somit Assets generieren, die über Slots in einer Seite dargestellt werden.

Abbildung 2. Page Rendering

1.3.2. Sprachen

Sowohl Salesforce- als auch FirstSpirit-seitig erfolgt die Pflege redaktioneller Inhalte in verschiedenen Sprachen. Für die Integration ist daher eine Zuordnung zwischen den Sprachen beider Systeme notwendig. Zu diesem Zweck wurde für die im Referenzprojekt verwendeten Sprachen eine Konvention bezüglich ihrer in FirstSpirit definierten Abkürzung getroffen. Diese orientiert sich an den in Salesforce bestehenden Sprachen und sieht vor, jede Abkürzung nach dem Schema SPRACHKÜRZEL_LÄNDERKÜRZEL zu benennen (vgl. Abbildung Sprachen). Dabei entspricht das Sprachkürzel dem ISO-639-Standard und das Länderkürzel dem ISO-3166-Standard.

Darüber hinaus wird im Projekt gewährleistet, dass die FirstSpirit-Mastersprache der Defaultsprache in Salesforce zugeordnet wird.

Abbildung 3. Sprachen

Dieser Sachverhalt wird in den Kapiteln Generierung sowie Homepage genauer behandelt.

Das Modul ContentConnect besitzt die folgenden technischen Voraussetzungen:

Dieses Kapitel enthält Hinweise, die bei der Verwendung des ContentConnect-Moduls zu beachten sind.

Das ContentConnect-Modul ist die Hauptkomponente der Verbindung zwischen FirstSpirit und der Commerce Cloud. Es hat eine maßgebliche Bedeutung für den bidirektionalen Datenaustausch zwischen dem FirstSpirit-Server und der Commerce Cloud.

Sowohl im SiteArchitect als auch im ContentCreator wird durch das Modul ein Report bereitgestellt. Dieser Report dient der Darstellung der Produktinformationen aus der Commerce Cloud. Stößt ein Redakteur eine entsprechende Abfrage an, ermittelt das Modul die gewünschten Daten und übergibt sie dem Report. Die zurückgelieferten Daten können anschließend für die Erstellung und Pflege redaktioneller Inhalte weiterverwendet werden.

Wird nach der Erstellung der Inhalte eine Generierung ausgeführt, fasst das Modul sie in Form zweier XML-Dateien zusammen. Die Dateien werden dann vom WebDAV-Modul in den Commerce Cloud Storage übermittelt. Aus diesem liest die Commerce Cloud die Daten aus und überträgt sie in den Live-Stand.

Die Erstellung und Bearbeitung der redaktionellen Inhalte findet FirstSpirit-seitig statt. Ihre Übertragung in den Live-Stand erfolgt hingegen durch die Commerce Cloud. Ihr müssen die Inhalte daher bereitgestellt werden. Dafür erstellt das ContentConnect-Modul im Rahmen eines Deployments jeweils eine XML-Datei für die Library und die Slot-Konfiguration. Sie müssen zusammen mit den referenzierten Medien an die Commerce Cloud übergeben werden.

Diese Aufgabe übernimmt das WebDAV-Modul. Es fungiert als Bindeglied zwischen FirstSpirit und der Commerce Cloud und legt die Daten im Commerce Cloud Storage ab. Aus diesem werden sie von der Commerce Cloud ausgelesen.

Innerhalb des Referenzprojekt ist für die Vorschau bestimmter Seiten die Verwendung von JSTL erforderlich. Dies ermöglicht das JSTL-Modul. Es muss jedoch nur dann auf dem FirstSpirit-Server installiert werden, wenn JSTL noch nicht anderweitig auf dem Server eingebunden ist.

Die Auslieferung enthält drei Cartridges: int_firstspirit_cms_core, int_firstspirit_cms_mfra und int_firstspirit_cms_sitegenesis.

Die Cartridge int_firstspirit_cms_core bietet Funktionen zum Import der in FirstSpirit erstellten redaktionellen Inhalte in die Commerce Cloud. Hierzu enthält sie die Pipeline ContentSync, die wiederum zwei Startknoten besitzt: LIBRARY und SLOT_CONFIGURATIONS (vgl. Abbildung Pipeline Content Sync). Über LIBRARY werden die redaktionellen Inhalte importiert, die Slot-Konfigurationen entsprechend über SLOT_CONFIGURATIONS. Für beide Fälle erwartet die Pipeline die Parameter ImportFile und ImportMode. Der Aufruf der Pipeline geschieht über Job Schedules. Hierfür definiert die Cartridge geeignete Job Step Types. Die Cartridge enthält außerdem Skripte, die in den anderen beiden Cartridges genutzt werden. Die bereitgestellten Funktionen dienen z. B. der Abbildung von Commerce Cloud Render Templates auf FirstSpirit-Seitenvorlagen, um damit das Anlegen von Kategorie- und Produktseiten zu ermöglichen (vgl. Product Page Template Uid, Category Page Template Mappings und Kategorie- und Produktseiten).

Die Cartridge int_firstspirit_cms_mfra überschreibt einige Vorlagen der MobileFirst Reference Architecture, um die FirstSpirit-seitige Vorschau zu ermöglichen. Außerdem enthält die Cartridge den Controller RenderTemplate, der für ein gegebenes Produkt oder eine gegebene Kategorie das Commerce Cloud Render Template ermittelt. Der Controller verwendet dabei die Möglichkeiten der MobileFirst Reference Architecture und greift auf die Funktionen der Cartridge int_firstspirit_cms_core zurück.

Für Shops, die nicht auf der MobileFirst Reference Architecture basieren, enthält die Cartridge int_firstspirit_cms_sitegenesis eine entsprechende Implementierung des Controllers RenderTemplate.

Abbildung 4. Pipeline Content Sync

In der Auslieferung sind drei Cartridges enthalten, die zunächst in die Commerce Cloud übertragen werden müssen. Verschiedene Methoden hierzu beschreibt die Commerce Cloud-Dokumentation unter Developing your storefront → Development components → Cartridges.

Anschließend muss die Cartridge int_firstspirit_cms_core allen Sites, die FirstSpirit-Inhalte empfangen sollen, sowie der Business-Manger-Site hinzugefügt werden. Entsprechende Instruktionen finden sich in der Commerce Cloud-Dokumentation unter Getting started → Getting started for developers → Registering your cartridge. Sites, die auf der MobileFirst Reference Architecture aufsetzen und in FirstSpirit gepflegt werden, benötigen in ihrem Cartridge-Pfad außerdem int_firstspirit_cms_mfra. Basiert eine Site hingegen auf SiteGenesis, muss ihr Cartridge-Pfad um int_firstspirit_cms_sitegenesis ergänzt werden.

Um die von FirstSpirit generierten Inhalte und Slot-Konfigurationen in die Commerce Cloud zu importieren, ist für jede Site ein Job Schedule in der Commerce Cloud anzulegen. Die Cartridge int_firstspirit_cms_core definiert dazu zwei Job Step Types:

Beide besitzen die Pflichtparameter Import File und Import Mode:

Für den Job Schedule empfiehlt sich die Verwendung eines Workflows mit zwei parallelen Flows. Jeder Flow kann dann einen der beiden oberen Job Steps aufrufen.

Neben den Cartridges enthält die Auslieferung im Verzeichnis metadata außerdem eine Export-Datei eines Job Schedules, die als Referenz genutzt werden kann und die Anlage der verschiedenen Job Schedules vereinfacht.

Nach dem Import sind weitere Anpassungen am Job Schedule notwendig. Der Scope beider Job Flows muss auf die richtige Site gesetzt werden. Ebenso ist der Import File-Parameter in beiden Job Steps anzupassen, so dass er den korrekten Pfad enthält.

Um von FirstSpirit verwaltete Assets und Slot-Konfigurationen, die innerhalb von FirstSpirit gelöscht wurden, auch aus der Commerce Cloud zu löschen, sind folgende Schritte zu befolgen:

Import der benutzerdefinierten System-Objekt-Attribute
Zur Persistierung von Zeitstempeln der Generierung benutzt die Content-Bereinigung innerhalb von Assets und Slot-Konfigurationen das benutzerdefinierte Attribut fsGenerationTime. Dieses muss den System-Objekten (Content und Slot-Konfigurationen) zunächst hinzugefügt werden. Für das Anlegen der benutzerdefinierten System-Objekt-Attribute muss die Export-Datei Custom-Attributes-Metadata.xml aus dem in der Auslieferung enthaltenden metadata-Verzeichnis importiert werden. Dafür sind die folgenden Schritte im Salesforce Business Manager duchzuführen:

Erzeugung von Search-Refinements für Assets
Für das neu erzeugte Attribut fsGenerationTime ist nach dem Import der System-Objekt-Attribute noch ein Commerce Cloud Search Refinement anzulegen. Dies beschreibt die Commerce Cloud-Dokumentation unter dem Punkt Merchandising your site → Content assets → Working with content assets → Creating content search refinements.

Unter anderem für die Reports und das Deployment wird die OC API eingesetzt. Für die verwendete Client ID müssen daher Salesforce-seitig die entsprechenden Rechte gesetzt werden.

Die verwendete Client ID benötigt Rechte zur Ausführung von GET-Anfragen über die ShopAPI auf folgende Ressourcen. Diese müssen je nach Anwendungsfall im globalen oder Site-spezifischen Kontext gesetzt werden.

Bei Verwendung der Content-Bereinigung außerdem:

Zusätzlich werden Rechte zur Ausführung von GET-, POST und DELETE-Anfragen über die DataAPI für folgende Ressourcen vorausgesetzt. Sie sind ausschließlich im globalen Kontext zu definieren.

Bei Verwendung der Content-Bereinigung außerdem:

Sollen optional Workflows zum Löschen von Library folder und Folder assignments verwendet werden, so sind Rechte zur Ausführung von DELETE-Anfragen über die DataAPI auf folgende Ressourcen notwendig:

Weiterführende Informationen zu den OC API Settings sind in der Commerce Cloud-Dokumentation enthalten.

Die ContentConnect-Auslieferung enthält drei Module, die auf dem FirstSpirit-Server hinzugefügt werden müssen. Öffnen Sie für die Installation der Module den ServerManager und wählen Sie den Bereich Server-Eigenschaften → Module.

Abbildung 5. Modulverwaltung in den Server-Eigenschaften

Im Hauptpanel ist eine Liste aller auf dem FirstSpirit-Server installierten Module zu sehen. Wählen Sie nach dem Klicken auf Installieren nacheinander zunächst die mitgelieferte contentconnect-fsm-<Versionsnummer>.fsm und anschließend die WebDavDeployment-<Versionsnummer>.fsm sowie die jstl.fsm aus. Bestätigen Sie die Auswahl jeweils mit Öffnen. Nach der erfolgreichen Installation wurden der Liste die Ordner ContentConnect, WebDavDeployment und JSTL hinzugefügt, von denen jeder Alle Rechte erhalten muss.

Die Installation der Module muss anschließend durch die Ergänzung des Apache Commons Codec in der Version 1.8 vervollständigt werden. Dabei handelt es sich um eine Bibliothek, die vom WebDAV-Modul verwendet wird.

Sie benötigen das Archiv commons-codec-1.8-bin.zip, welches Sie unter der folgenden URL herunterladen können: http://commons.apache.org/proper/commons-codec

Extrahieren Sie die Datei an einer beliebigen Stelle innerhalb ihres Dateisystems und separieren Sie das commons-codec-1.8.jar. Diese jar-Datei muss dem FirstSpirit-Server hinzugefügt werden. Öffnen Sie dafür das Verzeichnis Ihrer FirstSpirit-Installation, wechseln Sie in den Unterordner shared → lib und kopieren Sie die jar-Datei hinein.

Um den WebDAV-Server mit https statt http zu verwenden, ist grundsätzlich keine zusätzliche Konfiguration notwendig. Für https wird jedoch im Allgemeinen eine lokale vom Unternehmen verwaltete Zertifizierungsstelle verwendet. Dessen Zertifikat muss inklusive der gesamten Kette bis zum Zertifikat des WebDAV-Servers der JVM des FirstSpirit-Servers zur Verfügung gestellt werden.

Importieren Sie die öffentlichen Root- oder Zwischenzertifikate über das folgende Kommando in eine JKS-Datei und beantworten Sie die Frage, ob dem Zertifikat vertraut werden soll, mit Ja. Dieser Vorgang muss für jedes Zertifikat wiederholt werden.

keytool -import -file cert1.crt -keystore truststore.jks –storepass changeit

Kopieren Sie den erzeugten Trust Store in das Verzeichnis firstspirit5 → conf ihres FirstSpirit-Servers und fügen Sie die folgenden Zeilen der Datei firstspirit5 → conf → fs-wrapper.conf hinzu.

wrapper.java.additional.100=-Djavax.net.ssl.trustStore=conf/truststore.jks
wrapper.java.additional.101=-Djavax.net.ssl.trustStorePassword=changeit
wrapper.java.additional.102=-Djavax.net.ssl.trustStoreType=JKS

Sollte der WebDAV-Server eine wechselseitige SSL-Authentifizierung erwarten, muss über die folgenden Aufrufe zunächst ein Client-Zertifikat erstellt und signiert werden.

openssl genrsa -out private.key 2048
openssl req -new -key private.key -out request.csr

Die Datei request.csr wird an die Zertifizierungsstelle versandt, die mit der Datei cert.crt antwortet. Der private Schlüssel, das öffentliche Zertifikat und das Zertifikat der Zertifizierungsstelle müssen anschließend in einem von der JVM zu lesenden Key Store zusammengefasst werden.

cd firstspirit5/conf
openssl pkcs12 -export -in public.crt -inkey private.key \
-out clientcert.p12 -CAfile authority.crt

Falls die Zertifikatskette aus einem oder mehreren Zwischenzertifikaten besteht, können diese via keytool importiert werden.

keytool -import -file intermediate1.crt -trustcacerts \
-keystore clientcert.p12 -storepass changeit

Der Key Store lässt sich über das Hinzufügen der folgenden Zeilen in die firstspirit5 → conf → fs-wrapper.conf an die JVM des FirstSpirit-Servers übergeben.

wrapper.java.additional.103=-Djavax.net.ssl.keyStore=conf/clientcert.p12
wrapper.java.additional.104=-Djavax.net.ssl.keyStorePassword=changeit
wrapper.java.additional.105=-Djavax.net.ssl.keyStoreType=PKCS12

Ein Bestandteil des in der Auslieferung enthaltenen StarterPackages ist das Referenzprojekt ContentConnect Reference Project, das auf dem FirstSpirit-Server zu installieren ist. Öffnen Sie dafür im ServerManager den Import-Dialog über den Menüpunkt Projekt → Importieren und wählen Sie über den Button Lokal die Datei ContentConnectReferenceProject.tar.gz aus ihrem lokalen Dateisystem aus. Vergeben Sie anschließend einen Projektnamen sowie eine Beschreibung und bestätigen Sie den Import mit Ja. Nach der erfolgreichen Installation wurde das Projekt der Liste im Hauptpanel hinzugefügt (vgl. Abbildung Importiertes Projekt im ServerManager).

Abbildung 6. Importiertes Projekt im ServerManager

Für den Einsatz des ContentConnect-Moduls ist eine projektspezifische Konfiguration notwendig. Diese wird über die Projekt-Komponente vorgenommen, die dem mitgelieferten Referenzprojekt bereits hinzugefügt ist.

Öffnen Sie für die Konfiguration der Projekt-Komponente den ServerManager und wählen Sie den Bereich Projekt-Eigenschaften → Projekt-Komponenten. Im Hauptpanel ist eine Liste aller bereits vorhandenen Projekt-Komponenten zu sehen. Selektieren Sie den Eintrag ContentConnect Project Configuration und öffnen Sie den zugehörigen Konfigurationsdialog über Konfigurieren (vgl. Abbildung Konfigurationsdialog der Projekt-Komponente).

Abbildung 7. Konfigurationsdialog der Projekt-Komponente

Für die Vorschau und den ContentCreator werden zwei Web-Komponenten benötigt, die dem mitgelieferten Referenzprojekt bereits hinzugefügt sind. Sie müssen jedoch noch auf einem aktiven Webserver installiert werden. Öffnen Sie hierfür den ServerManager und wählen Sie den Bereich Projekt-Eigenschaften → Web-Komponenten.

Innerhalb des Hauptpanels sind verschiedene Registerkarten zu sehen, in denen jeweils eine Liste der bereits vorhandenen Web-Komponenten sichtbar ist. Diese Liste enthält sowohl für die Vorschau als auch für den ContentCreator die folgenden Einträge (vgl. Abbildung Web-Komponenten in den Projekt-Eigenschaften):

Selektieren Sie in beiden Registerkarten einen Webserver über die Auswahlbox und starten Sie die Installation jeweils über den Button Installieren. Nach der erfolgreichen Installation öffnet sich ein Dialog, in welchem die Aktivierung des Webservers zu bestätigen ist.

Detaillierte Informationen zum Hinzufügen von Web-Komponenten finden Sie in der FirstSpirit Dokumentation für Administratoren.

Abbildung 9. Web-Komponenten in den Projekt-Eigenschaften

Der ContentConnect Preview Filter ermittelt für die Darstellung einer Seite in der FirstSpirit-Vorschau die richtige Storefront-URL, lädt anhand dieser das HTML herunter und ersetzt die darin enthaltenen Slots durch die entsprechenden redaktionellen Inhalte. Für die Durchführung dieser Schritte benötigt er einige Informationen, die über diverse Parameter in der web.xml der hinzugefügten Web-Komponente (sowohl für die Vorschau als auch für den ContentCreator) konfigurierbar sind. Diese beziehen sich auf unterschiedliche Aspekte, die sich in drei Gruppen unterteilen lassen.

Storefront URL Parameter

Wie bereits beschrieben, lädt der Preview Filter das HTML einer Seite aus dem Storefront und ersetzt die enthaltenen Platzhalter durch redaktionelle Inhalte, um die Seite in der FirstSpirit-Vorschau darstellen zu können. Dafür ist eine projektspezifische Storefront-URL erforderlich. Da diese in den Projekteinstellungen gepflegt wird, benötigt der Preview Filter zur Abfrage die Angabe der zugehörigen Eingabekomponente.

Storefront Crop Marks Parameter

Die in den redaktionellen Inhalten enthaltenen Platzhalter bestehen jeweils aus einem Start- sowie End-Kommentar und besitzen standardmäßig das Format <!-- CMS-<IDENTIFIER>-START --> bzw. <!-- CMS-<IDENTIFIER>-END -->. Über ein Toggle in den Projekteinstellungen, das bei Bedarf hinzuzufügen ist, kann jedoch die Verwendung individueller Affixe aktiviert werden. In diesem Fall werden die Defaultwerte überschrieben und stattdessen die spezifischen Präfixe bzw. Suffixe verwendet. Um dem Preview Filter den Zugriff auf diese Informationen zu ermöglichen, benötigt er die Angabe der zugehörigen Eingabekomponenten.

Storefront Protection Parameter

Es besteht die Möglichkeit, die Verbindung zur Commerce Cloud über eine Authentifizierung zu schützen. Sie kann Salesforce-seitig de-/aktiviert werden und muss FirstSpirit-seitig über das entsprechende Toggle in den Projekteinstellungen übernommen werden. Im Fall der Aktivierung sind zusätzlich die benötigten Zugangsdaten anzugeben. Der Preview Filter muss auf diese Informationen zugreifen können und benötigt daher die Angabe der zugehörigen Eingabekomponenten.

Storefront Downloader Parameter

Zusätzlich zu den übrigen Parametern, die hauptsächlich der Ermittlung der richtigen Storefront-URL dienen, muss es möglich sein, das Verhalten des Preview Filters während des Herunterladens des HTMLs der entsprechenden Seite zu steuern. Dafür besitzt er verschiedene Parameter, die in den Projekteinstellungen pflegbar sind. Der Preview Filter muss auf diese Informationen zugreifen können und benötigt daher die Angabe der zugehörigen Eingabekomponenten.

Beispiel

Eine beispielhafte web.xml, in der zwei Parameter konfiguriert sind, könnte wie folgt aussehen:

Beispielhafte web.xml. 

<filter>
   <filter-name>ContentConnectPreviewFilter</filter-name>
   <filter-class>com.espirit.moddev.demandware.preview.PreviewFilter</filter-class>
   <init-param>
      <param-name>storefront.downloader.socketTimeout</param-name>
      <param-value>500</param-value>
   </init-param>
   <init-param>
      <param-name>storefront.downloader.retryCount</param-name>
      <param-value>5</param-value>
   </init-param>
</filter>

Das Referenzprojekt ContentConnect Reference Project besitzt unterschiedliche Absätze, mit denen sich auf den verschiedenen Seiten Bilder einbinden lassen. Die Bilder sollen durch den Redakteur auf einen bestimmten Bildausschnitt zugeschnitten werden können. Diese Funktionalität wird über die Angabe einer Auflösung aktiviert.

Angabe der Auflösung. 

$CMS_REF(st_picture, resolution:"RESOLUTION")$

Für das Referenzprojekt werden die Auflösungen BANNER, SLIDE, GRID_ELEMENT_HIGH, GRID_ELEMENT_WIDE, GRID_ELEMENT_SQUARE, IMAGE_MAP und TECHNOLOGY_IMAGE benötigt. Sie sind bereits innerhalb des ServerManagers im Bereich Projekt-Eigenschaften → Auflösungen angelegt und an den entsprechenden Stellen in den Absätzen angegeben.

Abbildung 10. Auflösungen

Für die Übermittlung der in FirstSpirit erstellten Inhalte in den Commerce Cloud Storage besitzt das mitgelieferte Referenzprojekt einen Auftrag, der die folgenden Aktionen enthält (vgl. Abbildung Aktionen des Generierungsauftrags). Eine Beschreibung der einzelnen Aktionen erfolgt in den nachfolgenden Unterkapiteln.

Weitere Informationen zur Erstellung eines Auftrags sind in der FirstSpirit Dokumentation für Administratoren zu finden.

Abbildung 11. Aktionen des Generierungsauftrags

4.9.1. Initialize SFCC Deployment

Im ersten Schritt erfolgt die Initialisierung des Deployments. Dies beinhaltet die Einrichtung der Content-Bereinigung, während der ein der Generierung vorausgehender Zeitstempel erzeugt wird. Diesen Zeitstempel verwendet die Cleanup-Aktion im letzten Schritt des Auftrags zur Löschung veralteter Assets und Slot-Konfigurationen. Der Auftrag enthält dafür die Aktion Salesforce Commerce Cloud Initializer:

Abbildung 12. Auftragsaktion

Für die Verwendung der Content-Bereinigung muss die Initialisierung zwingend die erste Aktion des Auftrags sein. Andernfalls kommt es zu Inkonsistenzen im Datenbestand.

4.9.2. Content Preparation - Vollgenerierung

Für das Deployment der für die Commerce Cloud relevanten Inhalte sind diese zunächst aus dem Projekt zu ermitteln. Dafür muss eine Vollgenerierung durchgeführt werden, die alle referenzierten Medien in der richtigen Auflösung generiert. Außerdem erzeugt sie die in den Projekteinstellungen initialisierten XML-Kollektoren und füllt sie anhand der in den Vorlagen enthaltenen xmlCollector-Aufrufe.

Der Auftrag besitzt daher die Generierungsaktion Content Preparation, in deren Eigenschaften die folgenden Optionen aktiviert sind (vgl. Abbildung Aktion Content Preparation):

• Vollgenerierung durchführen
• Generierungsverzeichnis vorher leeren
• Medien im Generierungsverzeichnis erzeugen

Das definierte Präfix für absolute Pfade /firstspirit wird in der Aktion WebDAV-Deployment benötigt.

Der Einsatz des WebDAV-Moduls ist nur in Verbindung mit dem Standard-URL-Creator möglich. Für die Pfaderzeugung ist daher der Eintrag Default URLs ausgewählt, der an dieser Stelle zwingend notwendig ist.

In der Registerkarte Erweitert sind außerdem die Vorlagensätze aller im Projekt vorhandenen Sprachen selektiert. Des Weiteren wurde die Variable dwre_xmlGeneration hinzugefügt, die den Wert false enthält. Sie wird in den nachfolgenden XML Import File-Aktionen auf den Wert true gesetzt und stellt sicher, dass die Erzeugung der XML-Dateien für die Slot-Konfigurationen und die Assets erst nach der Generierung erfolgt. Die Erzeugung der XML-Datei wird durch die im Projekt enthaltene XML-Vorlage gesteuert.

Abbildung 13. Aktion Content Preparation

4.9.3. XML Import File - Teilgenerierungen

Alle an die Commerce Cloud übermittelten Daten werden von dieser in Form von XML-Dateien erwartet. Aus diesem Grund müssen die während der Vollgenerierung ermittelten Informationen aus den erzeugten XML-Kollektoren ausgelesen werden. Sie sollen stattdessen in eine jeweils zu erstellende XML-Datei geschrieben werden.

Der Auftrag verfügt daher für jeden in den Projekteinstellungen initialisierten XML-Kollektor eine weitere Generierungsaktion. Im Gegensatz zur Aktion Content Preparation handelt es sich bei ihnen jedoch um Teilgenerierungen. In ihren Eigenschaften ist daher die Option Teilgenerierung durchführen für folgende Startpunkte aktiviert. Als Startpunkt dient jeweils eine der auf der XML-Vorlage basierenden Seitenreferenzen (vgl. Abbildung Teilgenerierung).

In der Registerkarte Erweitert jeder dieser Aktionen wurde außerdem die Variable dwre_xmlGeneration hinzugefügt, die den Wert true enthält. Zusammen mit dem jeweils ausgewählten Startknoten stellt sie sicher, dass die selektierte Seitenreferenz erst zu diesem Zeitpunkt generiert wird. Somit liegen alle benötigten Informationen für die Erstellung der XML-Datei bereits vor und es können keine Lücken auftreten. Die Erzeugung der XML-Datei wird durch die im Projekt enthaltene XML-Vorlage gesteuert.

Abbildung 14. Teilgenerierung

4.9.4. WebDAV-Deployment

Die mit den Teilgenerierungen erzeugten XML-Dateien müssen anschließend an die Commerce Cloud übermittelt werden. Die Publizierung erfolgt über eine Skript-Aktion, für die in ihren Eigenschaften folgende Parameter definiert sind:

Abbildung 15. Eigenschaften

url

Die URL gibt den Host und den Pfad auf dem WebDAV-Server an. Sie besitzt immer die folgende Struktur:

https://<SUBDOMAIN INSTANCE>.demandware.net/on/demandware.servlet/webdav/Sites/Impex/…​/<PREFIX>/<SITE ID>

Der Pfad entspricht dem Ort, an dem die jeweilige XML-Datei während des Imports erwartet wird. Er muss auf ein bereits existierendes Verzeichnis verweisen. Des Weiteren muss das Präfix dem Präfix für absolute Pfade der Vollgenerierung entsprechen.

user

Für die Übertragung der Daten wird ein technischer User benötigt, der zur Nutzung der WebDAV-Schnittstelle berechtigt ist. Er muss Schreibrechte besitzen und wird an dieser Stelle mit seinem Namen angegeben.

password

Für den zuvor angegebenen User wird zusätzlich die Angabe des Passworts benötigt.

Der technische Benutzer unterliegt den durch die Commerce Cloud definierten Passwort-Bestimmungen. Diese erfordern eine mindestens vierteljährliche Änderung des Passworts. Der Wert des Parameters muss in jedem dieser Fälle zwingend angepasst werden.

mediaurl

Der bei der Generierung erzeugte Medien-Ordner und sein Inhalt müssen in ein separates Verzeichnis übertragen werden, um der Commerce Cloud den Import zu ermöglichen. Dieses Verzeichnis ist über den Parameter mediaurl festgelegt. Die mediaurl besitzt immer die folgende Struktur:

http://<SUBDOMAIN INSTANCE>.demandware.net/on/demandware.servlet/webdav/Sites/Libraries/<SITE ID>/default/<PREFIX>

srcprefixdir

Soll nur ein bestimmtes Verzeichnis an die Commerce Cloud übertragen werden, kann es über den optionalen Parameter srcprefixdir relativ zum Root-Knoten des Generierungsverzeichnisses angegeben werden. Wird der Parameter nicht definiert oder für ihn kein Wert gespeichert, wird das gesamte Generierungsverzeichnis übertragen.

purge

Dieser Parameter ist optional und kann nur den Wert true oder false besitzen. Der Wert true bewirkt, dass alle Dateien und Verzeichnisse unterhalb der angegebenen URL vor dem Start der Übertragung gelöscht werden. Besitzt der Parameter den Wert false oder keinen Wert, bleiben alle bestehenden Dateien und Verzeichnisse unterhalb der angegebenen URL bestehen. Neue Daten werden entweder hinzugefügt oder im Fall bereits existierender Daten überschreiben sie diese.

Das WebDav-Deployment darf nicht im Fehlerfall ausgeführt werden.

4.9.5. Trigger SFCC Import Job Schedule

Nach der Publizierung der erzeugten XML-Dateien durch das WebDAV-Deployment wird der angelegte Job Schedule ausgeführt. Dieser löst Salesforce-seitig den Import der generierten Inhalte und Slot-Konfigurationen in die Commerce Cloud aus. Das ContentConnect-Modul stellt zu diesem Zweck die Auftragsaktion Salesforce Commerce Cloud Importer zur Verfügung:

Abbildung 16. Auftragsaktion

Die Aktion stellt einen Konfigurationsdialog bereit, in dem neben einem frei zu vergebenen Namen zwei Parameter zu definieren sind:

Abbildung 17. Parameter der Auftragsaktion

Import Job ID

Dieses Feld enthält die ID des angelegten Job Schedules.

Timeout

Der Wert in diesem Feld stellt die Zeitspanne in Sekunden dar, in der sekündlich der Status des Job Schedules abgefragt wird. Falls der Job Schedule in der angegebenen Zeitspanne nicht beendet wurde, wird diese Auftragsaktion als fehlerhaft gekennzeichnet. Der Defaultwert beträgt 10 Sekunden.

Da der Salesforce Commerce Cloud Importer ein erfolgreiches WebDAV-Deployment voraussetzt, darf auch dieser nicht im Fehlerfall ausgeführt werden.

4.9.6. Salesforce Commerce Cloud Cleanup

Nach der Ausführung des angelegten Job Schedules wird die Content-Bereinigung ausgeführt. Dabei werden alle veralteten Assets und Slot-Konfigurationen über die OC API abgefragt und anschließend gelöscht. Hierfür stellt das ContentConnect-Modul die Auftragsaktion Salesforce Commerce Cloud Cleanup zur Verfügung:

Abbildung 18. Auftragsaktion

Neben einem frei zu vergebenden Namen für diese Auftragsaktion enthält der dazugehörige Konfigurationsdialog folgende Parameter:

Abbildung 19. Parameter der Auftragsaktion

Library Id

In diesem Feld ist die ID der Content Library anzugeben. Im Fall einer privaten Libary entspricht die Library ID der Site ID.

Cleanup Content Assets

Diese Checkbox erlaubt die De-/Aktivierung der Content-Bereinigung von Assets.

Cleanup Slot Configurations

Diese Checkbox erlaubt die De-/Aktivierung der Content-Bereinigung von Slot-Konfigurationen.

Um Inkonsistenzen im Datenbestand bzw. einen Datenverlust zu vermeiden, muss die Aktion Salesforce Commerce Cloud Cleanup der letzten Aktion des Auftrags entsprechen. Aus demselben Grund setzt die Content-Bereinigung voraus, dass mit dieser Aktion ausschließlich Vollgenerierungen ausgeführt werden. Des Weiteren wird während der Ausführung des Cleanups von Replikationen innerhalb der Commerce Cloud abgeraten.

Da der Salesforce Commerce Cloud Cleanup eine erfolgreiche Ausführung des Job Schedules und somit den Import des Contents voraussetzt, darf auch dieser im Fehlerfall nicht ausgeführt werden.

Die Freigabe, das Löschen und die Publizierung von Inhalten durch Redakteure erfolgt innerhalb des mitgelieferten Referenzprojekts ContentConnect Reference Project über Arbeitsabläufe. Es enthält aus diesem Grund einen Publish-Arbeitsablauf sowie die BasicWorkflows, die alternativ zu projektspezifischen Arbeitsabläufen eingesetzt werden können.

Installation des BasicWorkflows-Moduls

Vor der Verwendung der Arbeitsabläufe muss zunächst das BasicWorkflows-Modul auf dem FirstSpirit-Server installiert und die Web-Komponente aktiviert sein. Die dafür notwendigen Schritte sind analog zur Installation der anderen Module und der Aktivierung der zugehörigen Web-Komponenten. Die Web-Komponente der BasicWorkflows wird allerdings nur in der Registerkarte ContentCreator benötigt.

Der Einsatz der BasicWorkflows im ContentCreator erfordert darüber hinaus die Auswahl des bereitgestellten BasicWorkflows Status Providers im Bereich Projekt-Eigenschaften → ContentCreator innerhalb des ServerManagers. Im Referenzprojekt ContentConnect Reference Project ist diese Einstellung bereits vorgenommen (vgl. Abbildung Element Status Provider).

Abbildung 20. Element Status Provider

Des Weiteren ist im Bereich Projekt-Eigenschaften → Optionen der Arbeitsablauf zum Löschen von Elementen vorausgewählt. Dies bewirkt, dass jede Handlung zum Löschen von Elementen innerhalb des Projekts (Entf-Taste, Lösch-Symbol) über ihn ausgeführt wird. Das native (von einem Arbeitsablauf unabhängige) Löschen von Elementen steht somit nicht zur Verfügung – auch nicht für den Administrator.

Vorlagen

Die BasicWorkflows sowie der mit dem StarterPackage mitgelieferte Arbeitsablauf benötigen verschiedene Vorlagen. Diese müssen für die BasicWorkflows üblicherweise über das Kontextmenü in das verwendete FirstSpirit-Projekt importiert werden. Im Referenzprojekt sind sie jedoch bereits vorhanden und ein Import der Vorlagen ist somit nicht notwendig.

Rechtevergabe

Im letzten Schritt müssen die Arbeitsabläufe in den einzelnen Verwaltungen erlaubt werden, um auf FirstSpirit-Elementen ausgeführt werden zu können. Dafür lässt sich auf den Root-Knoten der Verwaltungen über den Kontextmenüeintrag Extras → Rechte ändern die Rechtevergabe öffnen. Dieser Schritt ist im Referenzprojekt ebenfalls bereits durchgeführt und entfällt damit.

Nähere Informationen zu den BasicWorkflows finden Sie in der zugehörigen Dokumentation.

Für die Verbindung zwischen FirstSpirit und der Commerce Cloud sind einige projektspezifische Informationen unentbehrlich (vgl. Abbildung Projekteinstellungen). Sie werden über das Formular der Projekteinstellungen erfasst und sind innerhalb des Referenzprojekts anzugeben.

Abbildung 21. Projekteinstellungen

Des Weiteren werden mit der Vorlage zwei XML-Kollektoren und ein Produkt-Manager initialisiert, die in den anderen Seiten- und Absatzvorlagen des Projekts genutzt werden. In diesen Seiten- und Absatzvorlagen wird festgelegt, welche Daten an die Commerce Cloud übergeben werden sollen. Während der Generierung werden die Daten auf Basis dieser Festlegungen gesammelt und die XML-Kollektoren gefüllt.

Während die Erzeugung und Pflege redaktioneller Inhalte FirstSpirit-seitig erfolgt, bestimmt die Commerce Cloud das Rahmenwerk einer Seite. Für die Darstellung der Vorschau einer Seite fragt der ContentConnect Preview Filter daher ihre aktuelle Ansicht im Commerce Cloud Storefront ab und lädt das HTML herunter. Die darin enthaltenen Slots sind durch eindeutige HTML-Kommentare gekennzeichnet und werden in FirstSpirit durch die Inhaltsbereiche einer Seitenvorlage repräsentiert.

Redakteurssicht
Die Erstellung und Pflege redaktioneller Inhalte findet in FirstSpirit statt. Einem Redakteur stehen dafür die gewohnten Mittel zur Verfügung und er benötigt keine darüber hinausgehenden Kenntnisse. Die Inhalte beider Systeme werden aus der Sicht des Redakteurs automatisch zusammengeführt und in der Vorschau bzw. im ContentCreator dargestellt.

Entwicklersicht
Innerhalb des mitgelieferten Referenzprojekts werden die aus Salesforce stammenden Slots durch die Inhaltsbereiche der Seitenvorlagen repräsentiert. Ihnen können Absätze hinzugefügt werden, die jeweils einem Asset entsprechen und je nach Anwendungsfall zusätzlich eine Slot-Konfiguration besitzen. Für die Darstellung einer Seite in der Vorschau werden die im heruntergeladenen HTML enthaltenen Slots durch die redaktionellen Inhalte ersetzt.

Für die Ersetzung müssen alle für die Vorschau relevanten Inhalte durch eindeutige HTML-Kommentare gekennzeichnet sein. Diese können aus technischer Sicht in jeder Vorlage vorkommen, sind im Referenzprojekt jedoch nur in Seitenvorlagen enthalten. Sie bestehen jeweils aus einem Start- sowie End-Kommentar und besitzen standardmäßig das Format <!-- CMS-<IDENTIFIER>-START --> bzw. <!-- CMS-<IDENTIFIER>-END -->.

Sind darüber hinaus weitere Ersetzungen gewünscht, können spezifische Regex-Ausdrücke definiert werden. Diese besitzen eine eigene Syntax und weisen immer die folgende Form auf:

<!-- CMS-REGEX-PATTERN-START -->
   regex-match="<REGEX>"
   regex-value="<REPLACEMENT>"
<!-- CMS-REGEX-PATTERN-END -->

Während der Ausdruck regex-match die Regex speichert, entspricht der Ausdruck regex-value dem Inhalt, durch den alle Regex-Matches im Dokument ersetzt werden. Beide Ausdrücke sind durch die HTML-Kommentare <!-- CMS-REGEX-PATTERN-START --> und <!-- CMS-REGEX-PATTERN-END --> zu einer Anweisung zusammenzufassen.

Im Referenzprojekt wird auf diesem Weg beispielsweise in der Formatvorlage Preview Generation weiteres CSS in jede Seitenvorlage integriert oder jeglicher Link auf die Homepage ersetzt:

$-- Set Bootstrap CSS--$
<!-- CMS-REGEX-PATTERN-START -->
   regex-match="<\/head>"
   regex-value="$CMS_IF(#global.is("PREVIEW"))$$CMS_RENDER(template: "preview_css_additions")$$CMS_END_IF$</head>"
<!-- CMS-REGEX-PATTERN-END -->

$-- Change Homepage Reference --$
<!-- CMS-REGEX-PATTERN-START -->
   regex-match="href=("|').*.home[?]"
   regex-value="href="$CMS_REF(pageref:"homepage")$""
<!-- CMS-REGEX-PATTERN-END -->

ContentConnect Preview Proxy

Treten bei der Vorschau Probleme mit Cross-Origin Requests aufgrund der Same-Origin Policy moderner Webserver auf, so können diese durch den Einsatz des im ContentConnect-Modul enthaltenen Preview Proxys behoben werden.

Im mitgelieferten Referenzprojekt ist dies beispielsweise beim Laden der Font Awesome Schriftart über eine eingebundene CSS-Datei der Fall. Ohne Verwendung des Preview Proxys wird beim Laden der Schriftart ein Cross-Origin Request ausgeführt, der durch die Same-Origin Policy blockiert wird.

Um das Laden der betroffenen Ressourcen über den Preview Proxy zu leiten und somit Cross-Origin Requests zu vermeiden, enthält die Formatvorlage Preview Generation den nachfolgenden Regex-Ausdruck. Eine Konfigurationsanpassung des ausliefernden Webservers ist dabei nicht notwendig.

Einbindung des Proxys. 

$-- Redirect to proxy --$
<!-- CMS-REGEX-PATTERN-START -->
   regex-match="[^"'(]*?\/on\/demandware\.static\/"
   $CMS_IF(#global.is("WEBEDIT"))$
      regex-value="/fs5webedit_$CMS_VALUE(#global.project.id)$/s=****/proxy/on/demandware.static/"
   $CMS_ELSE$
      regex-value="/fs5preview_$CMS_VALUE(#global.project.id)$/proxy/on/demandware.static/"
   $CMS_END_IF$
<!-- CMS-REGEX-PATTERN-END -->

Fehlersuche

ContentConnect unterstützt Entwickler bei der Analyse von Problemen und Fehlern in der Vorschau, wie zum Beispiel fehlerhafte Ersetzungen oder schlechte Antwortzeiten bei der Vorschaugenerierung.

Entwickler können die URL einer Vorschauseite mit speziellen Parametern erweitern, um die Funktionsweise des Preview Filters zu beeinflussen und somit einige hilfreiche Informationen zu erhalten. Die zur Verfügung stehenden URL-Erweiterungen sind /debugTimings=true und /debugCCFilter=true.

Über /debugTimings=true wird der Preview Filter angewiesen, die Ausführungszeiten seiner Verarbeitungsschritte als Kommentar ans Ende des HTML-Dokuments zu schreiben. Dazu misst er die Dauer der folgenden Aktionen:

Bei der Angabe dieses Parameters erzeugt der Preview Filter für die Homepage des Referenzprojektes folgende Ausgabe:

Ausgabe des Preview Filters für die Homepage mit /debugTimings=true. 

<!--
*** TIMING STATS ***

LANGUAGE-DROPDOWN = 0ms
&lt;script [^&lt;]*?/dwux-init.js.*?&lt;/script&gt; = 0ms
[^&quot;'(]*/s/SiteGenesisGlobal_MF_SP/[^&quot;')]* = 53ms
Scanning for content replacement blocks = 1ms
CUSTOM-NAVIGATION-LEFT = 0ms
[^&quot;'(]*?/on/demandware.static/ = 113ms
(&lt;!-- dw.+?--&gt;) = 1ms
&lt;iframe.*?id=&quot;DW-SFToolkit&quot;&gt;.*?&lt;/iframe&gt; = 1ms
LANGUAGE-DROPDOWN-MOBILE = 0ms
&lt;a.*?sid=&quot;([^&quot;]*?)&quot; = 1ms
&lt;/head&gt; = 0ms
WILL-IGNORE-FOR-PREVIEW = 0ms
HOME-CATEGORIES = 0ms
href=(&quot;|').*.home[?] = 1ms
&lt;!-- Demandware Analytics(([sS]*)&lt;/script&gt;) = 1ms
&lt;!-- Demandware Active Data (([sS]*)&lt;/script&gt;) = 0ms
HOME-MAIN = 0ms
HOME-CC-OVERRIDE = 0ms

Total time = 172ms

-->

Des Weiteren protokolliert der Preview Filter bei der Angabe des Parameters /debugTimings=true einige Informationen im FirstSpirit-Server-Log.

Durch /debugCCFilter=true verzichtet der Preview Filter darauf den Storefront herunterzuladen, Ersetzungen durchzuführen und das Ergebnis in der Vorschau zu präsentieren. Stattdessen wird die tatsächlich von FirstSpirit generierte Seite in der Vorschau angezeigt. Neben den redaktionallen Inhalten sind im HTML deshalb auch die Ersetzungskommentare und -spezifikationen enthalten. Im Falle der Homepage des Referenzprojektes erzeugt der Preview Filter bei der Angabe dieses Parameters deshalb folgende (gekürzte) Ausgabe:

Ausgabe des Preview Filters für die Homepage mit /debugCCFilter=true. 

<!-- CMS-HOME-MAIN-START -->
    [...]
<!-- CMS-HOME-MAIN-END -->

<!-- CMS-HOME-CATEGORIES-START -->
    [...]
<!-- CMS-HOME-CATEGORIES-END -->

[...]

<!-- CMS-REGEX-PATTERN-START -->
    regex-match="href=("|').*.home[?]"
    regex-value="href="/fs5webedit_90169/s=qgkM/preview/90169/site/EN_GB/current/90172/90361""
<!-- CMS-REGEX-PATTERN-END -->

[...]

Die Nutzung dieser Funktionen erfordert den Aufruf einer Vorschauseite, deren Adresse um einen der vorgestellten Parameter ergänzt wurde. Dies kann auf verschiedene Weisen erfolgen:

<!-- CMS-REGEX-PATTERN-START -->
    regex-match="href=("|').*.home[?]"
    regex-value="href="$CMS_REF(pageref:"homepage")$/debugCCFilter=true""
<!-- CMS-REGEX-PATTERN-END -->

Zur Veröffentlichung von redaktionellen Inhalten generiert FirstSpirit zwei XML-Dateien, die Content Assets und Slot-Konfigurationen enthalten und an die Commerce Cloud übertragen werden. Der entsprechende Generierungs- und Deployment-Auftrag wurde bereits beschrieben. Dabei wurde auch darauf eingegangen, dass Vorlagen in ihren Ausgabekanälen XML-Kollektoren mit Inhalten (Content Assets) und Slot-Konfigurationen befüllen. Die Initialisierung dieser Kollektoren findet in den Projekteinstellungen statt. Es gilt, dass alle zu veröffentlichen Inhalte und Konfigurationen in die XML-Kollektoren geschrieben werden müssen. Andernfalls werden sie nicht übertragen.

Allgemein wird für jeden Absatz ein Asset und eine Slot-Konfiguration erzeugt, wodurch eine Personalisierung auf Absatzebene ermöglicht wird. Eine Ausnahme stellen lediglich Inhaltsseiten dar, für die insgesamt genau ein Content Asset und eine Slot-Konfiguration entsteht.

Dieses Kapitel erläutert, wie die Inhalte und Konfigurationen des Projektes gesammelt und die XML-Dateien generiert werden.

$CMS_SET(set_xml_id, ps_dwAssetIdPrefix + "-" + #global.node.uid + "-" + #global.section.id)$
$CMS_SET(set_xml_id, set_xml_id.replaceAll("_","-"))$

$CMS_SET(void, ps_xmlCollector.useOrCreateContentNode(set_xml_id))$

$CMS_SET(void, ps_xmlCollector.addContentAttribute({
    "name":"display-name",
    "value":#global.node.getDisplayName(#global.language).toString(),
    "attributes":{
        "xml:lang":set_xml_lang
    }
}))$

$CMS_SET(void, ps_xmlCollector.addContentAttribute({
    "name":"searchable-flag",
    "value":"true"
}))$

$CMS_SET(void, ps_xmlCollector.addContentAttribute({
    "name":"online-flag",
    "value":"true"
}))$

$CMS_SET(void, ps_xmlCollector.addCustomAttribute({
    "id":"body",
    "cdata":set_xml_body.toString(),
    "attributes":{
        "xml:lang":set_xml_lang
    }
}))$

$CMS_SET(void, ps_xmlCollector.addFolderAttribute({
    "id":set_parent_id
}))$

$CMS_IF(!st_slotConfig.isEmpty)$
    $CMS_FOR(_slotConfig,st_slotConfig)$
        $CMS_VALUE(_slotConfig)$
    $CMS_END_FOR$
$CMS_END_IF$

$CMS_SET(void, ps_xmlCollectorContentSlot.addXml(null, set_slotConfig.toString(), null))$

Die Navigation zwischen verschiedenen Kategorieseiten innerhalb der Vorschau erfolgt in erster Linie über das Hauptmenü (vgl. Abbildung Navigation). Das Hauptmenü ist Bestandteil des während der Vorschau vom Commerce Cloud Storefront heruntergeladenen HTMLs und somit durch die Commerce Cloud vorgegeben.

Abbildung 22. Navigation

Redakteurssicht
Das Hauptmenü ermöglicht dem Redakteur den Wechsel zwischen Kategorieseiten. Existiert für eine angesteuerte Kategorieseite ein Äquivalent innerhalb von FirstSpirit, so wird der Inhalt dieser Seite dargestellt. Der Redakteur hat anschließend die Möglichkeit, den aus FirstSpirit stammenden Inhalt zu editieren. Existiert innerhalb von FirstSpirit kein Äquivalent zur angesteuerten Kategorieseite, wird hingegen der originale, aus der Commerce Cloud bezogene Inhalt ausgegeben.

Entwicklersicht
Um dem Redakteur im Falle einer in FirstSpirit existierenden Kategorieseite diese anzuzeigen, werden im Referenzprojekt zunächst über einen spezifischen Regex-Ausdruck die Navigationslinks des Hauptmenüs auf eine sogenannte Dispatcher-Seite umgeleitet.

Umleitung der Navigationslinks. 

$-- Change Category Reference --$
<!-- CMS-REGEX-PATTERN-START -->
   regex-match="<a.*?\sid="([^"]*?)""
   regex-value="<a href="$CMS_REF(pageref:"preview_dispatcher")$?type=category&id=$1" id="$1""
<!-- CMS-REGEX-PATTERN-END -->

Dieser Regex-Ausdruck ist neben einigen anderen spezifischen Regex-Ausdrücken Teil der Formatvorlage Preview Generation.

Bei dem in diesem Ausdruck referenzierten Preview Dispatcher handelt es sich um eine technische Seite auf Basis der gleichnamigen Seitenvorlage. Der Preview Dispatcher iteriert durch Verwendung der FirstSpirit Navigationsfunktion über den Inhalt des Struktur-Ordners category_pages.

Dabei merkt sich der Preview Dispatcher für jede vorgefundene Seite die dazugehörige Kategorie zusammen mit einer entsprechenden Referenz auf die Seite. Somit kann er anschließend bei jedem Aufruf entscheiden, ob zu der angeforderten Kategorie eine Seite innerhalb von FirstSpirit existiert, und eine entsprechende Weiterleitung vornehmen.

Konnte zur einer angeforderten Kategorie keine in FirstSpirit angelegte Seite ermittelt werden, so erfolgt eine Weiterleitung auf eine generische Kategorie-Vorschauseite.

Die Homepage entspricht der Startseite des mitgelieferten Referenzprojekts und wird daher initial beim Öffnen des ContentCreators angezeigt. Da sich ihr Aufbau von dem der übrigen Inhaltsseiten unterscheidet, besitzt sie eine eigene Vorlage. Diese wird im Projekt nur ein einziges Mal referenziert.

Redakteurssicht
Die Homepage bietet dem Redakteur drei Möglichkeiten zur Inhaltspflege:

Die für die Inhaltspflege notwendigen Absätze werden in den entsprechenden Unterkapiteln näher erläutert.

Entwicklersicht
Die Homepage-Vorlage definiert hauptsächlich ihre Darstellung in der FirstSpirit-Vorschau, während die Generierung der Assets vorrangig in den eingebundenen Absätzen stattfindet. Dennoch werden sowohl im Formular als auch im HTML-Kanal einige Voraussetzungen für die Generierung geschaffen. Die Entwicklersicht muss daher beide Aspekte berücksichtigen.

Vorschau
Die Commerce Cloud unterstützt verschiedene Seitentypen. Für die Darstellung der redaktionellen Inhalte in der FirstSpirit-Vorschau bzw. im ContentCreator muss FirstSpirit die richtige Storefront-URL erzeugen, um die zugehörige Seite in der Commerce Cloud abfragen zu können.

Der für die FirstSpirit-Vorschau zu verwendende Seitentyp wird im Formularfeld Preview Page Type definiert. Da für die Homepage nur der Parameter Home existiert, ist er als Vorgabewert gewählt und die Eingabekomponente versteckt.

Für die Ermittlung der gewünschten Storefront-URL ist darüber hinaus sicherzustellen, dass die in FirstSpirit und in der Commerce Cloud genutzten Sprachkürzel aufeinander abgestimmt sind. Diese Aufgabe erfüllt die Formatvorlage language_mapping, die im HTML-Kanal eingebunden ist. Ohne übereinstimmende Sprachkürzel ist es FirstSpirit nicht möglich, die entsprechende Seite für die Vorschau zu ermitteln.

Die Ausgabe der für die Homepage gepflegten Absätze erfolgt innerhalb eindeutiger HTML-Kommentare. Diese bestehen immer aus einem Start- und einem End-Ausdruck und kennzeichnen die einzelnen Inhaltsbereiche. Anhand der Kommentare tauscht FirstSpirit die Slots in der Vorschau gegen redaktionelle Inhalte aus.

<!-- CMS-HOME-MAIN-START -->
   $CMS_VALUE(#global.page.body("home_main"))$
   $CMS_RENDER(template:"empty_content_slot",label:"Home Main",body:"home_main")$
<!-- CMS-HOME-MAIN-END -->

<!-- CMS-HOME-CATEGORIES-START -->
   $CMS_VALUE(#global.page.body("home_categories"))$
   $CMS_RENDER(template:"empty_content_slot",label:"Home Categories",body:"home_categories")$
<!-- CMS-HOME-CATEGORIES-END -->

<!-- CMS-HOME-CC-OVERRIDE-START -->
   $CMS_RENDER(template: "cc_createsectionwe_api")$
<!-- CMS-HOME-CC-OVERRIDE-END -->

Besitzt ein Inhaltsbereich keine Absätze, stellt FirstSpirit stattdessen in der Vorschau einen grau hinterlegten Bereich dar (vgl. Abbildung Empty Slot). Dieser zeigt den Namen des Inhaltsbereichs an und besitzt einen Button, über den sich im ContentCreator neue Absätze erzeugen lassen. Die Anzeige des grauen Bereichs steuert die Formatvorlage empty_content_slot, während die Funktionalität des Buttons in der Formatvorlage cc_createsectionwe_api realisiert ist. Sie enthält JavaScript, das lediglich einmal in die Seite eingebunden werden darf.

Abbildung 23. Empty Slot

Sind über den Austausch der Slots hinaus weitere Ersetzungen gewünscht, können spezifische Regex-Ausdrücke definiert werden. Diese besitzen eine eigene Syntax und sind in der Formatvorlage Preview Generation zusammengefasst. Sie steuert die Erzeugung der Vorschau und wird in allen Seitenvorlagen des Referenzprojekts referenziert.

Generierung
Die während der Generierung erzeugten Assets werden Salesforce-seitig in einer Ordnerstruktur abgelegt. Im Referenzprojekt ist daher für jede Seitenvorlage ein entsprechender Ordner definiert. Das Homepage-Formular besitzt dafür das versteckte Feld SFCC Parent Folder, dessen Wert der Variable set_parent_id zugewiesen wird. Ihre Auswertung erfolgt in den eingebundenen Absätzen.

$CMS_SET(set_parent_id,pt_sfcc_parentFolder)$

Eine weitere Voraussetzung für die Generierung der Assets ist, dass die entsprechende Seite in FirstSpirit als übersetzt markiert ist. Ist dies nicht der Fall, wird die Generierung abgebrochen.

$CMS_IF(!#global.preview && !#global.page.isTranslated)$
   $CMS_SET(#global.stopGenerate, true)$
$CMS_END_IF$

Die Inhaltsseiten entsprechen den Standardseiten des Projekts und werden mehrfach referenziert. Sie nehmen im Gegensatz zur Homepage sowie zu den Kategorie- und Produktseiten eine besondere Rolle ein, da sie lediglich ein Asset für die gesamte Seite generieren. In diesem Asset werden alle redaktionellen Inhalte der Inhaltsseite und der ihr hinzugefügten Absätze zusammengefasst.

Redakteurssicht
Die Inhaltsseiten bieten dem Redakteur drei Möglichkeiten zur Inhaltspflege:

Die für die Inhaltspflege notwendigen Absätze werden in den entsprechenden Unterkapiteln näher erläutert. Da der Text-Absatz selbsterklärend ist, wird er nicht einzeln beschrieben.

Entwicklersicht
Im Gegensatz zu den übrigen Seiten werden die redaktionellen Inhalte der Inhaltsseite und ihrer Absätze in einem einzigen Asset zusammengefasst. Die Erzeugung dieses Assets erfolgt im HTML-Kanal der Seitenvorlage, der zwischen der Darstellung der Seite in der FirstSpirit-Vorschau und im Live-Stand unterscheidet. Die Entwicklersicht muss daher beide Aspekte berücksichtigen.

Vorschau

Da die Erzeugung des Assets lediglich die Generierung beeinflusst, sind die beiden Entwicklersichten der Inhaltsseite und der Homepage in Bezug auf die FirstSpirit-Vorschau nahezu identisch.

Die einzige Divergenz zwischen beiden Vorlagen besteht in der Konfiguration des verwendeten Seitentyps, der für die Inhaltsseiten ebenfalls im versteckten Formularfeld Preview Page Type definiert wird. Im Gegensatz zur Homepage kann er theoretisch unterschiedliche Werte annehmen. Für das vorliegende Referenzprojekt wird jedoch der Parameter Page benötigt, der als Vorgabewert ausgewählt ist.

Des Weiteren besitzt die Inhaltsseite das versteckte Formularfeld SFCC Context ID, in dem eine Default-ContentAsset-ID gespeichert ist. Da eine Seite vor der Generierung noch keine Asset-ID besitzt, wird sie für die Erzeugung der Vorschau benötigt.

Generierung

Für die Generierung muss im ersten Schritt sichergestellt werden, dass die entsprechende Seite in FirstSpirit als übersetzt markiert ist. Nur, wenn dies der Fall ist, wird die Generierung durchgeführt und das Asset für die Inhaltsseite erzeugt.

$CMS_IF(!#global.preview && !#global.page.isTranslated)$
   $CMS_SET(#global.stopGenerate, true)$
$CMS_END_IF$

Dafür wird der Variablen set_parent_id zunächst der Wert des versteckten Feldes SFCC Parent Folder zugewiesen. Er gibt an, wo das erzeugte Asset Salesforce-seitig in dessen Ordnerstruktur abgelegt wird.

$CMS_SET(set_parent_id,pt_sfcc_parentFolder)$

Die Auswertung der Variablen erfolgt während der Befüllung des XML-Kollektors, die im Anschluss durchgeführt wird. Dabei wird ein neuer Content Node erzeugt, dem unter anderem die redaktionellen Inhalte der Seite hinzugefügt werden.

Sowohl im SiteArchitect als auch im ContentCreator stellt das ContentConnect-Modul jeweils einen Report für Produkte und Kategorien bereit. Sie dienen der Darstellung der aus Commerce Cloud stammenden Kategorie- und Produktinformationen, die für die Erstellung und Pflege redaktioneller Inhalte verwendet werden können (vgl. Abbildung Reports).

Abbildung 24. Reports

Über den entsprechenden Report können sowohl Produktseiten als auch Kategorie-Landingpages angelegt werden. Dafür muss in der Projekt-Komponente definiert sein, auf welchen Vorlagen diese Seiten basieren und wo sie in der Struktur einzubinden sind.

<CMS_INPUT_TEXT name="pt_storefrontUrlContextId" hidden="yes" useLanguages="no">
  <LANGINFOS>
    <LANGINFO lang="*" label="SFCC Context ID"/>
  </LANGINFOS>
</CMS_INPUT_TEXT>

Ein Objekt im Report kann bezüglich seiner Kategorie- bzw. Produktseite einen von drei Zuständen besitzen:

Die drei Fälle werden unterschiedlich visualisiert und nachfolgend beschrieben.

Anlegen einer Kategorie- oder Produktseite

Objekte, die noch keine Produktseite bzw. Kategorie-Landingpage besitzen, werden im Report durch ein graues Icon markiert (vgl. Abbildung Anlegen einer Kategorie- bzw. Produktseite). Wurde in der Projekt-Komponente eine Seitenvorlage definiert, erscheint beim Überfahren eines solchen Objekts die Schaltfläche .

Abbildung 25. Anlegen einer Kategorie- bzw. Produktseite

Per Klick auf diese Schaltfläche öffnet sich ein zweigeteilter Dialog, mit dem sich für das entsprechende Objekt eine Seite anlegen lässt.

Der obere Teil des Dialogs ist der Struktur-Auswahl-Bereich, der automatisch eingefügt wird und damit immer gleich ist. Er stellt dem Redakteur die Möglichkeit zur Verfügung, innerhalb der Struktur die Menüebene auszuwählen, in der die neue Seite erzeugt wird. Potentiell ist die entsprechende Eingabekomponente schon vorbelegt. Dann wurde im Konfigurationsdialog der Projekt-Komponente bereits ein Struktur-Ordner definiert. Es steht dem Redakteur jedoch frei, diese Auswahl anzupassen.

Im Gegensatz zum Struktur-Auswahl-Bereich ist der untere Formular-Bereich immer projektspezifisch. Er zeigt das Formular der in der Projekt-Komponente angegebenen Seitenvorlage. In ihm gelten außerdem die in der Vorlage definierten Regeln.

Die folgende Abbildung zeigt einen beispielhaften Dialog:

Abbildung 26. Dialog zum Anlegen einer Kategorie- bzw. Produktseite

Ein Klick auf Anlegen erzeugt die Seitenreferenz der Produktseite bzw. Kategorie-Landingpage in der zuvor gewählten Menüebene. Die zugehörige Seite wird in einem festem Ordner in der Inhalteverwaltung erstellt.

Ist innerhalb der Projekt-Komponente außerdem ein Skript angegeben, so wird dieses üblicherweise vor und nach der Erzeugung der Kategorie- bzw. Produktseite ausgeführt. Das im mitgelieferten Referenzprojekt enthaltene Skript create_sfcc_item_wizard besitzt jedoch eine entsprechende Abfrage, aufgrund welcher es nur im Anschluss an die Erzeugung der Seite angestoßen wird. Es markiert die jeweils erzeugte Produktseite bzw. Kategorie-Landingpage für alle Sprachen als übersetzt und speichert ihre Storefront-ID im Formular.

Diesem Skript werden die folgenden Parameter übergeben:

Nach der vollständigen Erzeugung der Produktseite bzw. Kategorie-Landingpage und dem Ausführen des Skriptes wird die neu erstellte Seite automatisch aufgerufen.

Aufruf einer vorhandenen Kategorie- bzw. Produktseite
Objekte, für die bereits eine Kategorie- bzw. Produktseite existiert, werden im Report durch ein grünes Icon markiert (vgl. Abbildung Produkt mit Produktseite). Sie erhalten beim Überfahren die Schaltfläche , mit der die zugehörige Produktseite oder Kategorie-Landingpage aufgerufen werden kann.

Abbildung 27. Produkt mit Produktseite

Defekte Referenz auf eine Kategorie- bzw. Produktseite
Besitzt ein Objekt eine Produktseite oder Kategorie-Landingpage, für die jedoch die Seitenreferenz oder die zugrunde liegende Seite nicht gefunden werden kann, so wird das Objekt im Report mit einem roten Icon markiert (vgl. Abbildung Objekt mit Defekt). Solche Objekte erhalten beim Überfahren die Schaltfläche . Ein Klick auf diese Schaltfläche öffnet einen Dialog, der weitere Informationen bereit hält.

Abbildung 28. Objekt mit Defekt

Versteckte Kategorien
Beim Aufruf des Kategorie-Reports werden standardmäßig sowohl sichtbare als auch versteckte Kategorien angezeigt. Durch das Entfernen des Hakens Include hidden categories kann die Ergebnisliste auf sichtbare Kategorien eingeschränkt werden:

Abbildung 29. Ausblenden versteckter Kategorien

$CMS_IF(!#global.preview && !#global.page.isTranslated || pt_storefrontUrlContextId.isEmpty)$
   $CMS_SET(#global.stopGenerate, true)$
$CMS_END_IF$

<CMS_INPUT_TOGGLE name="pt_hideNewPageDialogCC" hFill="yes" hidden="yes" singleLine="no">
  <LANGINFOS>
    <LANGINFO
      lang="*"
      label="Hide New Page Dialog in ContentCreator"
      description="Hide the dialog in the ContentCreator when creating a new landing page."
    />
  </LANGINFOS>
</CMS_INPUT_TOGGLE>

<CMS_INPUT_TOGGLE name="pt_hideNewPageDialogSA" hFill="yes" hidden="yes" singleLine="no">
  <LANGINFOS>
    <LANGINFO
      lang="*"
      label="Hide New Page Dialog in SiteArchitect"
      description="Hide the dialog in the SiteArchitect when creating a new landing page."
    />
  </LANGINFOS>
</CMS_INPUT_TOGGLE>

Im Kopfbereich einer Seite lässt sich ein Banner anzeigen, in dem entweder ein statisches Bild oder ein Slider eingebunden werden kann. Beide Varianten entsprechen jeweils einem Absatz, der sowohl für die Homepage als auch für normale Inhaltsseiten sowie für Kategorie- und Produktseiten verfügbar ist.

Sie werden in den nachfolgenden Unterkapiteln näher beschrieben.

Abbildung 30. Slider

$CMS_RENDER(template:"media_link",mediaref: st_picture,res:"SLIDE")$

5.7.2. Banner Image

Das Banner Image entspricht einem statischen Bild, das im Kopfbereich einer Seite angezeigt wird.

Redakteurssicht
Die Auswahl des statischen Banner-Bildes erfolgt entweder über die Medienverwaltung oder durch das Hochladen eines neuen Bildes. Es lässt sich mithilfe der gewohnten FirstSpirit-Funktionalität auf einen gewünschten Bildausschnitt zuschneiden.

Darüber hinaus stehen dem Redakteur mit dem Absatz folgende weitere Konfigurarionsmöglichkeiten zur Verfügung:

• Pflege eines einzeiligen Titels
• Angabe eines Links auf eine Produkt- oder Kategorie-Landingpage
• Definition der Größe und der Darstellung des Banners

Ein eingegebener Titel wird blau hinterlegt und lässt sich rechts, links oder mittig auf dem Banner-Bild positionieren. Dabei ist festzulegen, ob die blaue Hinterlegung in der rechten bzw. linken Position nur als schmaler Streifen oder über die gesamte Höhe des Banners angezeigt wird. In der mittleren Position verläuft sie grundsätzlich über die gesamte Höhe. Die Eingabekomponente für die Positionierung wird erst mit der Eingabe des Titels sichtbar und ist ansonsten ausgeblendet.

Die Angabe eines Links auf eine Produkt- oder Kategorie-Landingpage erfolgt über die Angabe eines Linktextes und der zugehörigen Produkt- oder Kategorie-ID. Beide Felder werden bei der Übernahme eines Produkts oder einer Kategorie aus einem der beiden Reports heraus automatisch befüllt. Da der Link sich auf das gesamte Banner-Bild bezieht, wird sein Linktext nur als Tooltip verwendet und nicht als klickbarer Verweis dargestellt.

Für die Definition der Größe des Banners stehen dem Redakteur die Optionen Small und Big zur Auswahl.
Die Option Small minimiert die Höhe des Banners und stellt ihn nur als schmalen Streifen dar. Dies hat zur Folge, dass ein selektiertes Bild potentiell unten abgeschnitten wird.
Die Option Big zeigt den Banner ohne eine Einschränkung der Höhe und befähigt den Redakteur darüber hinaus eine Decoration zu bestimmen.

Für die Decoration existieren die Optionen none, up und down. Die Option none nimmt keinerlei Veränderung am Banner vor, während ihm bei den anderen beiden Optionen eine weiße Überlagerung in der linken oberen bzw. in der rechten unteren Ecke hinzugefügt wird.

Abbildung 31. Banner Image mit der Decoration 'up'

Entwicklersicht
Der HTML-Kanal referenziert das ausgewählte Bild und gibt es unter Berücksichtigung des vom Redakteur definierten Bildausschnitts und Layouts zusammen mit dem konfigurierten Titel und Verweis aus. Für den Zuschnitt des Bildes wird die Auflösung BANNER benötigt, die bereits in den Projekt-Eigenschaften des Referenzprojekts angelegt ist und im HTML angegeben werden muss:

Angabe der Auflösung. 

$CMS_RENDER(template:"media_link",mediaref:st_picture,res:"BANNER")$

Die Eingabekomponente st_picture besitzt den Parameter upload=yes, der dem Redakteur zusätzlich zur Auswahl eines bestehenden Bildes aus der Medienverwaltung das Hochladen neuer Bilder ermöglicht.

Der gesamte Inhalt wird der Variablen set_sectionContent zugewiesen, die während der Generierung der Homepage bzw. einer Kategorie- oder Produktseite für die Befüllung der entsprechenden XML-Datei benötigt wird. Im Fall einer Inhaltsseite wird die Variable hingegen lediglich ausgegeben.

Da das Bild aus der Medienverwaltung des FirstSpirit-Projekts referenziert wird und somit keine Ersetzung von Salesforce-Inhalten erfolgt, muss es nicht durch HTML-Tags gekennzeichnet sein.

Im Gegensatz zu schlichten Inhaltsseiten besitzen die Homepage und Kategorie-Landingpages die Möglichkeit , über den Grid Container eine Gruppe von drei bis fünf Bildern anzuzeigen, die alle einem Grid Container Element entsprechen.

Abbildung 32. Grid Container

Redakteurssicht
Mit dem Grid Container besitzt der Redakteur die Möglichkeit, eine Liste von Bildern zu erstellen, für die er jeweils einen Titel sowie einen Verweis auf eine Produkt-, Kategorie- oder Inhaltsseite angeben kann. Aus dieser Liste werden je nach Konfiguration drei bis fünf Bilder dargestellt, die sich einzeln auf einen gewünschten Bildausschnitt zuschneiden lassen. Die Bilder können entweder aus der Medienverwaltung stammen oder mithilfe der Eingabekomponente hochgeladen werden.

Die Anordnung der Bilder erfolgt nach einem bestimmten Layout, das der Redakteur zuvor bestimmt. Dafür stehen ihm die folgenden sieben Optionen zur Verfügung.

Abbildung 33. Grid Container - Layoutoptionen

Entwicklersicht
Innerhalb des HTML-Kanals werden in Abhängigkeit des vom Redakteur gewählten Bildausschnitts und Layouts die ausgewählten Bilder referenziert und die für sie konfigurierten Titel und Verweise ausgegeben. Dabei wird lediglich die dem Layout entsprechende Anzahl Bilder berücksichtigt und jeder weitere Eintrag ignoriert.

Für den Zuschnitt der Bilder werden die Auflösungen GRID_ELEMENT_SQUARE, GRID_ELEMENT_HIGH und GRID_ELEMENT_WIDE benötigt. Sie sind bereits in den Projekt-Eigenschaften des Referenzprojekts angelegt und müssen im HTML angegeben werden:

Angabe der Auflösung. 

$CMS_REF(st_picture, resolution:"GRID_ELEMENT_SQUARE")$
$CMS_REF(st_picture, resolution:"GRID_ELEMENT_HIGH")$
$CMS_REF(st_picture, resolution:"GRID_ELEMENT_WIDE")$

Die Eingabekomponente st_picture besitzt den Parameter upload=yes, der dem Redakteur zusätzlich zur Auswahl eines bestehenden Bildes aus der Medienverwaltung das Hochladen neuer Bilder ermöglicht.

Der Inhalt wird der Variablen set_sectionContent zugewiesen, die während der Generierung der Homepage oder einer Kategorie-Landingpage für die Befüllung der entsprechenden XML-Datei benötigt wird.

Da die Bilder aus der FirstSpirit-Medienverwaltung referenziert werden und keine Ersetzung von Salesforce-Inhalten stattfindet, müssen sie nicht durch HTML-Tags gekennzeichnet sein und werden wie gewohnt in der Vorschau dargestellt.

Zusätzlich zum Grid Container können Produkte in Form sogenannter Hot Spots auf einer Seite dargestellt werden. Jeder Hot Spot entspricht einem Produktlink, der parallel zu den anderen Hot Spots auf einem einzigen statischen Bild definiert ist. Per Klick öffnet sich pro Hot Spot ein Flyout, das den Namen, ein Bild und eine Beschreibung des entsprechenden Produkts enthält.

Die Auswahl des statischen Bildes und die Definition der Hot Spots erfolgt mithilfe der Absatzvorlage Shop the look, die nur der Homepage sowie Inhaltsseiten hinzugefügt werden kann.

Abbildung 34. Hot Spots

Redakteurssicht
Neben dem statischen Bild kann der Redakteur einen aus maximal zwanzig Zeichen bestehenden Titel angeben, der sich links, rechts oder mittig auf dem Bild positionieren lässt. Das Bild kann entweder aus der Medienverwaltung ausgewählt oder per Drag & Drop auf den im Formular verfügbaren Button Upload a picture hochgeladen werden. Es lässt sich mithilfe der bekannten FirstSpirit-Funktionalität zuschneiden.

Auf dem Bild kann der Redakteur eine beliebige Anzahl von Hot Spots erstellen, indem er einen Bildausschnitt wählt und für diesen einen Produktlink definiert. Der Link erwartet einen Linktext und eine Produkt-ID. Beide Felder werden bei der Übernahme eines Produkts aus dem Produkte-Report heraus automatisch befüllt. Nach dem Speichern des Formulars werden die erzeugten Hot Spots an der entsprechenden Stelle auf dem Bild dargestellt, wobei der gewählte Linktext dem dargestellten Produktname entspricht.

Entwicklersicht
Der HTML-Kanal referenziert zunächst das ausgewählte Bild und gibt es zusammen mit dem Titel aus. Anschließend erfolgt die Ermittlung und Positionierung der Hot Spots anhand der vom Redakteur festgelegten Bildausschnitte. Für jeden Hot Spot wird außerdem das ihm zugehörige Flyout erzeugt, das bei einem Klick auf ihn erscheint und automatisch die entsprechenden Produktinformationen anzeigt.

Der gesamte Inhalt wird der Variablen set_sectionContent zugewiesen, die während der Generierung der Homepage für die Befüllung der entsprechenden XML-Datei benötigt wird. Im Fall einer Inhaltsseite wird die Variable hingegen lediglich ausgegeben.

Da das Bild aus der Medienverwaltung des FirstSpirit-Projekts referenziert wird und somit keine Ersetzung von Salesforce-Inhalten erfolgt, muss der Inhalt nicht durch HTML-Tags gekennzeichnet sein.

Im Gegensatz zur Homepage und zu Kategorie-Landingpages besitzen Inhaltsseiten die Möglichkeit, Blog-Artikel darzustellen. Jeder Blog-Artikel entspricht einem Datensatz der Datenquelle Article und muss zunächst vom Redakteur erzeugt werden.

Mithilfe zweier Tabellenvorlagen kann die Darstellung entweder in Form einer Übersicht aller verfügbaren Blog-Artikel oder als Detailansicht eines einzigen Artikels erfolgen. Beide Optionen werden in den nachfolgenden Unterkapiteln beschrieben.

5.10.1. Artikel-Übersicht

Die Artikel-Übersicht stellt alle im Projekt enthaltenen Blog-Artikel sortiert nach ihrem Erstellungsdatum dar. Die Anzeige beschränkt sich dabei jeweils auf die Überschrift eines Artikels sowie den Teaser und das Teaserbild.

Abbildung 35. Artikel-Übersicht

Redakteurssicht
Da die Übersicht automatisch erzeugt wird, kann der Redakteur lediglich die Anzahl der anzuzeigenden Blog-Artikel sowie ihre Verteilung auf eine oder mehrere Seiten definieren. Die Konfiguration erfolgt entsprechend der bekannten FirstSpirit-Funktionalität im Daten-Tab der zugehörigen Seitenreferenz.

Davon abgesehen besitzt der Redakteur keine über die Einbindung der Tabellenvorlage hinausgehenden Zugriff auf die Funktionalität.

Entwicklersicht
Der HTML-Kanal der Tabellenvorlage ermittelt die Datensätze der Datenquelle Article und gibt nacheinander jeweils die Überschrift, den Teaser und das Teaserbild aller Blog-Artikel aus. Die einzelnen Artikel sind dabei durch eine horizontale Linie getrennt und ihre Überschrift entspricht dem Link auf die zugehörige Detailseite.

Für die Verlinkung der Detailseite muss ihr Referenzname der Übersichtsseite bekannt sein. Im Referenzprojekt wurde der Referenzname der zugehörigen Seitenreferenz (magazine_article) daher fest in die Vorlage der Übersichtsseite übernommen. In individuellen Szenarien ist sie daher entsprechend anzupassen.

Des Weiteren ist an erster Stelle vor der Liste der Blog-Artikel eine Navigationsfunktion eingefügt, die - bei einer Verteilung der Blog-Artikel auf mehrere Seiten - das Durchblättern ermöglicht. Werden alle Blog-Artikel auf einer einzigen Seite dargestellt, ist die Navigation ausgeblendet.

Neben rein textuellen Informationen kann eine Seite im Referenzprojekt auch Videos enthalten. Jedes Video entspricht einem Absatz, der verschiedene Konfigurationsmöglichkeiten bereitstellt. Die zugehörige Absatzvorlage kann sowohl Inhaltsseiten als auch Kategorie-Landingpages, jedoch nicht der Homepage hinzugefügt werden.

Redakteurssicht
Für die Referenzierung von Videos stehen einem Redakteur die Plattformen Youtube und Vimeo zur Auswahl. Beide Anbieter verwenden eine eindeutige ID, die jeweils Bestandteil der Video-URL ist:

Anhand dieser ID lässt sich das entsprechende Video der Seite hinzufügen. Es wird standardmäßig im Format 16:9 angezeigt. Zusätzlich sind jedoch die Optionen 21:9, 4:3 oder 1:1 verfügbar. Darüber hinaus kann der Redakteur definieren, ob die Wiedergabe automatisch startet und ob die Anzeige des Videos im Vollbild zulässig ist.

Entwicklersicht
Innerhalb des HTML-Kanals wird zunächst in Abhängigkeit der definierten Video-Plattform das ausgewählte Video referenziert. Dabei werden entsprechend der Konfiguration des Redakteurs im Formular das Darstellungsformat sowie die verschiedenen URL-Parameter gesetzt und letztendlich die richtige Video-URL erzeugt.

Dieser Inhalt wird der Variablen set_sectionContent zugewiesen, die während der Generierung einer Kategorie-Landingpage für die Befüllung der entsprechenden XML-Datei benötigt wird. Im Fall einer Inhaltsseite wird die Variable hingegen lediglich ausgegeben.

Da das eingebundene Video nicht aus der Commerce Cloud stammt, muss es nicht durch HTML-Tags gekennzeichnet sein. Es wird ohne Ersetzung in der Vorschau angezeigt.

Das mitgelieferte Referenzprojekt verwendet als Mastersprache Englisch. Darüber hinaus besitzt es die Projektsprachen Italienisch, Französisch, Japanisch und Chinesisch. Um die Ansicht einer Seite auf eine dieser Sprachen umschalten zu können, bietet das Projekt in der Vorschau einen Sprachwechsel an. Dieser wird in Abhängigkeit der verwendeten Bildschirmgröße entweder in Form eines Dropdowns oder innerhalb eines Menüs angezeigt.

Abbildung 38. Sprachwechsel

Redakteurssicht
Der Sprachwechsel wird innerhalb der Vorschau des Referenzprojekts sowohl auf der Homepage als auch auf Inhaltsseiten sowie auf Kategorie- und Produktseiten angezeigt. Auf diese Weise erhält der Redakteur auf jeder Seite die Möglichkeit, redaktionelle Inhalte für alle im Projekt bestehenden Sprachen zu pflegen.

Da die zur Auswahl stehenden Sprachen automatisch auf Basis der Projektsprachen ermittelt werden und die Darstellung ebenfalls nicht beeinflussbar ist, besitzt der Redakteur keinen über die reine Verwendung hinausgehenden Zugriff auf die Funktionalität.

Entwicklersicht
Der Sprachwechsel wird durch die Formatvorlage Language Dropdown erzeugt und mit der Formatvorlage Preview Generation in der Vorschau bereitgestellt. Dabei wird er in Abhängigkeit der Bildschirmgröße entweder in Form eines Dropdowns oder innerhalb eines Menüs angezeigt (vgl. Abbildung Sprachwechsel).

Beide Varianten referenzieren die Formatvorlage Language Dropdown, welche die Anzeige der Varianten über den zu übergebenden Parameter showInMenu steuert. Da der Sprachwechsel jeweils den entsprechenden Salesforce-Inhalt ersetzt, müssen beide Varianten durch eindeutige HTML-Kommentare gekennzeichnet sein.

Sprachwechsel in der Formatvorlage Preview Generation. 

$-- Preview Language Switch --$
<!-- CMS-LANGUAGE-DROPDOWN-START -->
   $CMS_RENDER(template:"sfcc_language_dropdown", mobile:false)$
<!-- CMS-LANGUAGE-DROPDOWN-END -->

<!-- CMS-LANGUAGE-DROPDOWN-MOBILE-START -->
   $CMS_RENDER(template:"sfcc_language_dropdown", mobile:true)$
<!-- CMS-LANGUAGE-DROPDOWN-MOBILE-END -->

Die Formatvorlage Language Dropdown ermittelt zunächst die aktuell in der Vorschau dargestellte Sprache und zeigt diese zusammen mit dem entsprechenden Icon als ersten Eintrag des Dropdowns bzw. des Sprachmenüs an. Im Anschluss wird die Liste aller im Projekt bestehenden Sprachen abgefragt und mit Ausnahme der zuvor ermittelten Sprache als weitere Auswahlmöglichkeiten bereitgestellt.

Die FirstSpirit-seitig gepflegten, redaktionellen Inhalte beinhalten Verweise, mit denen sie sich untereinander verknüpfen lassen. Des Weiteren können mithilfe der Verweise Dokumente zum Download bereitgestellt oder Kontaktmöglichkeiten angeboten werden.

Sie basieren auf verschiedenen Verweisvorlagen, die in den nachfolgenden Unterkapiteln näher beschrieben werden.

$CMS_IF(lt_linkTags)$
   <a href="$CMS_VALUE(lt_url)$"
    $CMS_IF(!lt_linktext.isEmpty)$ title="$CMS_VALUE(lt_linktext)$"$CMS_END_IF$
    target="_blank">
      $CMS_VALUE(lt_linktext, default: "Link")$
   </a>
$CMS_ELSE$
   href="$CMS_VALUE(lt_url)$"
   $CMS_IF(!lt_linktext.isEmpty)$ title="$CMS_VALUE(lt_linktext)$"$CMS_END_IF$
   target="_blank"
$CMS_END_IF$

Innerhalb des mitgelieferten Referenzprojekts ContentConnect Reference Project werden Assets durch Absätze repräsentiert. Sie besitzen je nach Anwendungsfall eine Slot-Konfiguration, die eine zielgruppenspezifische und individuell auf den Kunden zugeschnittene Auslieferung redaktioneller Inhalte ermöglicht.

Redakteurssicht
Die Möglichkeit zur Konfiguration eines Slots wird einem Redakteur im Referenzprojekt in Form einer Eingabekomponente bereitgestellt. Sie ist in den für ihn verfügbaren Absätzen enthalten und darf maximal eine einzelne Slot-Konfiguration enthalten.

Die Slot-Konfiguration kann durch den Redakteur de-/aktiviert sowie als Default-Konfiguration für den zugehörigen Slot ausgewählt werden. Darüber hinaus ermöglicht sie die Definition der aus Salesforce bekannten Schedule-Parameter. Durch das Hinzufügen mehrerer Absätze desselben Typs (z.B. mehrere Slider), die jedoch unterschiedliche Slot-Konfigurationen besitzen, lassen sich auf diese Weise unterschiedliche Inhaltsvarianten realisieren.

Entwicklersicht
Eine einzelne Slot-Konfiguration wird durch die Verweisvorlage SFCC Slot Configuration repräsentiert, die innerhalb der folgenden Absätze von der Eingabekomponente Slot Configuration verwendet wird:

Innerhalb des HTML-Kanals der Verweisvorlage wird in Abhängigkeit der vom Redakteur definierten Konfiguration das von der Commerce Cloud erwartete XML erzeugt und in den vorgesehenen Collector geschrieben. Die Übertragung des XMLs in die Commerce Cloud erfolgt durch ein Deployment.

Die Freigabe, das Löschen und die Veröffentlichung von Inhalten erfolgt innerhalb des mitgelieferten Referenzprojekts ContentConnect Reference Project über Arbeitsabläufe. Es enthält aus diesem Grund einen Publish-Arbeitsablauf sowie die BasicWorkflows.

Redakteurssicht
Die BasicWorkflows bieten einem Redakteur die Möglichkeit, geänderte Inhalte freizugeben bzw. FirstSpirit-Elemente sowohl aus dem Current- als auch aus dem Freigabestand zu entfernen. Beide Arbeitsabläufe basieren auf dem Vier-Augen-Prinzip und werden immer im Kontext einer Seite ausgeführt. Tritt während der Ausführung eines Arbeitsablaufs ein Konflikt auf, kann er nach dessen Behebung fortgesetzt werden.

Für die Salesforce-seitige Synchronisierung der im FirstSpirit-Projekt durchgeführten Änderungen steht einem Redakteur der Publish-Arbeitsablauf zur Verfügung. Er stößt den Deployment-Auftrag an und wird somit kontextlos ausgeführt. Aus diesem Grund wird er im ContentCreator über das Aktionen-Menü und im SiteArchitect über die Aufgabenliste gestartet. Der Deployment-Auftrag überträgt alle freigegebenen Inhalte in die Commerce Cloud und veranlasst die Salesforce-seitige Löschung von Assets und Slot-Konfigurationen, die in FirstSpirit entfernt wurden.

Abbildung 39. Publish-Arbeitsablauf im ContentCreator

Entwicklersicht
Der Freigabe- und der Lösch-Arbeitsablauf entsprechen denen des BasicWorkflows-Moduls und wurden nicht verändert. Der Freigabe-Arbeitsablauf orientiert sich an der administrativen Direktfreigabe und stellt deren Funktionalität dem Redakteur bereit. Der Lösch-Arbeitsablauf ermöglicht die Entfernung von Elementen aus dem Current- und dem Freigabestand.

Zur Übertragung der im FirstSpirit-Projekt vorgenommenen Änderungen, wurde dem Referenzprojekt zusätzlich der Publish-Arbeitsablauf hinzugefügt. Dieser ermittelt anhand des Skripts SFCC Release Deployment den Deployment-Auftrag und führt ihn aus. Im Gegensatz zu den anderen beiden Arbeitsabläufen bezieht er sich somit explizit nicht auf eine einzige Seite. Aus diesem Grund ist in seinen Eigenschaften die Option Arbeitsablauf ohne Kontext ausführbar aktiviert.

Abbildung 40. Optionen des Publish-Arbeitsablaufs